Deprecate misspell and replace it with typos #419
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SuperSandro2000
requested review from
Nuckal777,
VoigtS,
majewsky and
wagnerd3
as code owners
majewsky
requested changes
Nov 27, 2025
SuperSandro2000
force-pushed
the
typos
branch
from
133f55f to
ab1c742
Compare
Copilot finished reviewing on behalf of
SuperSandro2000
November 27, 2025 16:32
There was a problem hiding this comment.
Pull request overview
This PR replaces the deprecated misspell linter with typos for spell checking across the repository. The migration introduces a new typos configuration system, updates build tools and CI workflows, and adds validation to prevent use of the deprecated configuration.
- Adds a new
typosconfiguration section with support for excluding files and customizing word mappings - Removes
misspellfrom golangci-lint and GitHub Actions workflows, replacing it with thetyposaction - Adds validation to fail fast if the deprecated
spellCheck.ignoreWordsconfiguration is used
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| internal/core/config.go | Adds TyposConfiguration struct, deprecates SpellCheckConfiguration, adds validation to enforce migration |
| internal/core/constants.go | Replaces MisspellAction constant with TyposAction constant |
| internal/typos/typos.go | New package implementing typos configuration rendering with automatic exclusion of go.mod and vendor/ |
| internal/typos/typos.toml.tmpl | Template for generating .typos.toml configuration file |
| internal/golangcilint/golangci_lint.go | Removes MisspellIgnoreWords from template data |
| internal/golangcilint/golangci.yaml.tmpl | Removes misspell linter and its ignore-rules configuration |
| internal/ghworkflow/workflow_checks.go | Replaces misspell action with typos action, removes unused imports and permission requirements |
| internal/makefile/makefile.go | Adds run-typos target generation when typos is enabled |
| internal/nix/nix-shell.go | Adds typos to nix packages list when enabled |
| main.go | Adds typos.RenderConfig call when typos is enabled |
| shell.nix | Adds typos to nix shell dependencies |
| Makefile | Adds run-typos target with installation instructions |
| README.md | Updates documentation replacing spellCheck section with typos section including configuration examples |
| .typos.toml | New typos configuration file for the project itself |
| .golangci.yaml | Removes misspell linter from enabled linters list |
| .github/workflows/checks.yaml | Replaces misspell action with typos action, removes pull-requests permission |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
SuperSandro2000
force-pushed
the
typos
branch
from
c6e2779 to
85cedf5
Compare
majewsky
requested changes
Dec 2, 2025
Contributor
majewsky
left a comment
majewsky
left a comment
There was a problem hiding this comment.
Change looks good, and GHE allowlist was extended. Please address the CI error, then this is good to go.
Member
Author
|
This is what I mean by misspell doesn't find things 😂 |
SuperSandro2000
force-pushed
the
typos
branch
from
85cedf5 to
ee830dd
Compare
SuperSandro2000
force-pushed
the
typos
branch
from
ee830dd to
a01d9e7
Compare
Contributor
Merging this branch will decrease overall coverage
Coverage by fileChanged files (no unit tests)
Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code. |
majewsky
requested changes
Dec 2, 2025
Contributor
majewsky
left a comment
majewsky
left a comment
There was a problem hiding this comment.
Change looks good, and GHE allowlist was extended. Please address the CI error, then this is good to go.
| "CLICOLOR": "1", | ||
| }, | ||
| }) | ||
| j.addStep(jobStep{ |
Contributor
There was a problem hiding this comment.
As always, surprising actions should be documented.
Suggested change
| j.addStep(jobStep{ | |
| // TyposAction drops its binary into the repository root; if we do not clean this up, | |
| // `reuse lint` will complain about it not having license information | |
| j.addStep(jobStep{ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #259